FlowScript
Represents a workflow step for executing custom scripts with error management options.
Properties
| Name | Description |
|---|---|
| Key | A unique identifier for the workflow step. |
| WorkflowCodeInstance | The workflow code instance associated with the flow object. |
| CachedDMObjects | The cached document management objects related to the flow object. |
| TypeCode | The type code associated with the flow object. |
| ResumeOnError | Indicates whether the script execution should continue in case of an error. (Marked as obsolete) |
| ErrorDescriptionObjectName | The name of the object used to store error descriptions. (Marked as obsolete) |
| ErrorOptions | Defines error-related options for the API step. |
| Name | Name for the workflow step. |
| Value | The value or output generated by the script. |
| Caption | The caption dictionary representing localized captions for the flow object. |
Constructors
| Name | Description |
|---|---|
| FlowScript(name, workflowData, workflowCodeInstance) | Constructor for the FlowScript class. Initializes a new instance of the FlowScript class. |
| FlowScript(name,workflowData,workflowCodeInstance) | Initializes a new instance of the FlowScript class with a name, workflow data, and workflow code instance. |
| FlowScript(name,workflowData,workflowCodeInstance) | Initializes a new instance of the FlowScript class with a name, workflow data, and workflow code instance. |
Methods
| Name | Description |
|---|---|
| Initialize() | Initializes the script step with default settings. |
| ToLiquid() | Converts the script data into a format compatible with Liquid templates. |
Events
| Name | Description |
|---|---|
| OnBeforeExecution(sender, args) | Occurs before the execution of the workflow step. |
| OnAfterExecution(sender, args) | Occurs after the execution of the workflow step. |
Generic Types
| Name | Description |
|---|---|
| TProperties | Generic type of properties. |